<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US">
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<title>WebSocketServerHandshakerFactory xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../../../api/org/jboss/netty/handler/codec/http/websocketx/WebSocketServerHandshakerFactory.html">View Javadoc</a></div><pre>

<a class="jxr_linenumber" name="1" href="#1">1</a>   <em class="jxr_comment">/*</em>
<a class="jxr_linenumber" name="2" href="#2">2</a>   <em class="jxr_comment"> * Copyright 2012 The Netty Project</em>
<a class="jxr_linenumber" name="3" href="#3">3</a>   <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="4" href="#4">4</a>   <em class="jxr_comment"> * The Netty Project licenses this file to you under the Apache License,</em>
<a class="jxr_linenumber" name="5" href="#5">5</a>   <em class="jxr_comment"> * version 2.0 (the "License"); you may not use this file except in compliance</em>
<a class="jxr_linenumber" name="6" href="#6">6</a>   <em class="jxr_comment"> * with the License. You may obtain a copy of the License at:</em>
<a class="jxr_linenumber" name="7" href="#7">7</a>   <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="8" href="#8">8</a>   <em class="jxr_comment"> *   <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
<a class="jxr_linenumber" name="9" href="#9">9</a>   <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="10" href="#10">10</a>  <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing, software</em>
<a class="jxr_linenumber" name="11" href="#11">11</a>  <em class="jxr_comment"> * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT</em>
<a class="jxr_linenumber" name="12" href="#12">12</a>  <em class="jxr_comment"> * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the</em>
<a class="jxr_linenumber" name="13" href="#13">13</a>  <em class="jxr_comment"> * License for the specific language governing permissions and limitations</em>
<a class="jxr_linenumber" name="14" href="#14">14</a>  <em class="jxr_comment"> * under the License.</em>
<a class="jxr_linenumber" name="15" href="#15">15</a>  <em class="jxr_comment"> */</em>
<a class="jxr_linenumber" name="16" href="#16">16</a>  <strong class="jxr_keyword">package</strong> org.jboss.netty.handler.codec.http.websocketx;
<a class="jxr_linenumber" name="17" href="#17">17</a>  
<a class="jxr_linenumber" name="18" href="#18">18</a>  <strong class="jxr_keyword">import</strong> org.jboss.netty.channel.Channel;
<a class="jxr_linenumber" name="19" href="#19">19</a>  <strong class="jxr_keyword">import</strong> org.jboss.netty.channel.ChannelFuture;
<a class="jxr_linenumber" name="20" href="#20">20</a>  <strong class="jxr_keyword">import</strong> org.jboss.netty.handler.codec.http.DefaultHttpResponse;
<a class="jxr_linenumber" name="21" href="#21">21</a>  <strong class="jxr_keyword">import</strong> org.jboss.netty.handler.codec.http.HttpHeaders.Names;
<a class="jxr_linenumber" name="22" href="#22">22</a>  <strong class="jxr_keyword">import</strong> org.jboss.netty.handler.codec.http.HttpRequest;
<a class="jxr_linenumber" name="23" href="#23">23</a>  <strong class="jxr_keyword">import</strong> org.jboss.netty.handler.codec.http.HttpResponse;
<a class="jxr_linenumber" name="24" href="#24">24</a>  <strong class="jxr_keyword">import</strong> org.jboss.netty.handler.codec.http.HttpResponseStatus;
<a class="jxr_linenumber" name="25" href="#25">25</a>  <strong class="jxr_keyword">import</strong> org.jboss.netty.handler.codec.http.HttpVersion;
<a class="jxr_linenumber" name="26" href="#26">26</a>  
<a class="jxr_linenumber" name="27" href="#27">27</a>  <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="28" href="#28">28</a>  <em class="jxr_javadoccomment"> * Instances the appropriate handshake class to use for servers</em>
<a class="jxr_linenumber" name="29" href="#29">29</a>  <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="30" href="#30">30</a>  <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../../org/jboss/netty/handler/codec/http/websocketx/WebSocketServerHandshakerFactory.html">WebSocketServerHandshakerFactory</a> {
<a class="jxr_linenumber" name="31" href="#31">31</a>  
<a class="jxr_linenumber" name="32" href="#32">32</a>      <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> String webSocketURL;
<a class="jxr_linenumber" name="33" href="#33">33</a>  
<a class="jxr_linenumber" name="34" href="#34">34</a>      <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> String subprotocols;
<a class="jxr_linenumber" name="35" href="#35">35</a>  
<a class="jxr_linenumber" name="36" href="#36">36</a>      <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> allowExtensions;
<a class="jxr_linenumber" name="37" href="#37">37</a>  
<a class="jxr_linenumber" name="38" href="#38">38</a>      <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">long</strong> maxFramePayloadLength;
<a class="jxr_linenumber" name="39" href="#39">39</a>  
<a class="jxr_linenumber" name="40" href="#40">40</a>      <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="41" href="#41">41</a>  <em class="jxr_javadoccomment">     * Constructor</em>
<a class="jxr_linenumber" name="42" href="#42">42</a>  
<a class="jxr_linenumber" name="43" href="#43">43</a>  <em class="jxr_javadoccomment">     * @param subprotocols</em>
<a class="jxr_linenumber" name="44" href="#44">44</a>  <em class="jxr_javadoccomment">     *            CSV of supported protocols. Null if sub protocols not supported.</em>
<a class="jxr_linenumber" name="45" href="#45">45</a>  <em class="jxr_javadoccomment">     * @param allowExtensions</em>
<a class="jxr_linenumber" name="46" href="#46">46</a>  <em class="jxr_javadoccomment">     *            Allow extensions to be used in the reserved bits of the web socket frame</em>
<a class="jxr_linenumber" name="47" href="#47">47</a>  <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="48" href="#48">48</a>      <strong class="jxr_keyword">public</strong> <a href="../../../../../../../org/jboss/netty/handler/codec/http/websocketx/WebSocketServerHandshakerFactory.html">WebSocketServerHandshakerFactory</a>(String webSocketURL, String subprotocols, <strong class="jxr_keyword">boolean</strong> allowExtensions) {
<a class="jxr_linenumber" name="49" href="#49">49</a>          <strong class="jxr_keyword">this</strong>(webSocketURL, subprotocols, allowExtensions, Long.MAX_VALUE);
<a class="jxr_linenumber" name="50" href="#50">50</a>      }
<a class="jxr_linenumber" name="51" href="#51">51</a>  
<a class="jxr_linenumber" name="52" href="#52">52</a>      <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="53" href="#53">53</a>  <em class="jxr_javadoccomment">     * Constructor</em>
<a class="jxr_linenumber" name="54" href="#54">54</a>  <em class="jxr_javadoccomment">     *</em>
<a class="jxr_linenumber" name="55" href="#55">55</a>  <em class="jxr_javadoccomment">     * @param webSocketURL</em>
<a class="jxr_linenumber" name="56" href="#56">56</a>  <em class="jxr_javadoccomment">     *            URL for web socket communications. e.g "ws://myhost.com/mypath".</em>
<a class="jxr_linenumber" name="57" href="#57">57</a>  <em class="jxr_javadoccomment">     *            Subsequent web socket frames will be sent to this URL.</em>
<a class="jxr_linenumber" name="58" href="#58">58</a>  <em class="jxr_javadoccomment">     * @param subprotocols</em>
<a class="jxr_linenumber" name="59" href="#59">59</a>  <em class="jxr_javadoccomment">     *            CSV of supported protocols. Null if sub protocols not supported.</em>
<a class="jxr_linenumber" name="60" href="#60">60</a>  <em class="jxr_javadoccomment">     * @param allowExtensions</em>
<a class="jxr_linenumber" name="61" href="#61">61</a>  <em class="jxr_javadoccomment">     *            Allow extensions to be used in the reserved bits of the web socket frame</em>
<a class="jxr_linenumber" name="62" href="#62">62</a>  <em class="jxr_javadoccomment">     * @param maxFramePayloadLength</em>
<a class="jxr_linenumber" name="63" href="#63">63</a>  <em class="jxr_javadoccomment">     *            Maximum allowable frame payload length. Setting this value to your application's</em>
<a class="jxr_linenumber" name="64" href="#64">64</a>  <em class="jxr_javadoccomment">     *            requirement may reduce denial of service attacks using long data frames.</em>
<a class="jxr_linenumber" name="65" href="#65">65</a>  <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="66" href="#66">66</a>      <strong class="jxr_keyword">public</strong> <a href="../../../../../../../org/jboss/netty/handler/codec/http/websocketx/WebSocketServerHandshakerFactory.html">WebSocketServerHandshakerFactory</a>(String webSocketURL, String subprotocols, <strong class="jxr_keyword">boolean</strong> allowExtensions,
<a class="jxr_linenumber" name="67" href="#67">67</a>              <strong class="jxr_keyword">long</strong> maxFramePayloadLength) {
<a class="jxr_linenumber" name="68" href="#68">68</a>          <strong class="jxr_keyword">this</strong>.webSocketURL = webSocketURL;
<a class="jxr_linenumber" name="69" href="#69">69</a>          <strong class="jxr_keyword">this</strong>.subprotocols = subprotocols;
<a class="jxr_linenumber" name="70" href="#70">70</a>          <strong class="jxr_keyword">this</strong>.allowExtensions = allowExtensions;
<a class="jxr_linenumber" name="71" href="#71">71</a>          <strong class="jxr_keyword">this</strong>.maxFramePayloadLength = maxFramePayloadLength;
<a class="jxr_linenumber" name="72" href="#72">72</a>      }
<a class="jxr_linenumber" name="73" href="#73">73</a>  
<a class="jxr_linenumber" name="74" href="#74">74</a>      <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="75" href="#75">75</a>  <em class="jxr_javadoccomment">     * Instances a new handshaker</em>
<a class="jxr_linenumber" name="76" href="#76">76</a>  <em class="jxr_javadoccomment">     *</em>
<a class="jxr_linenumber" name="77" href="#77">77</a>  <em class="jxr_javadoccomment">     * @return A new WebSocketServerHandshaker for the requested web socket version. Null if web</em>
<a class="jxr_linenumber" name="78" href="#78">78</a>  <em class="jxr_javadoccomment">     *         socket version is not supported.</em>
<a class="jxr_linenumber" name="79" href="#79">79</a>  <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="80" href="#80">80</a>      <strong class="jxr_keyword">public</strong> <a href="../../../../../../../org/jboss/netty/handler/codec/http/websocketx/WebSocketServerHandshaker.html">WebSocketServerHandshaker</a> newHandshaker(<a href="../../../../../../../org/jboss/netty/handler/codec/http/HttpRequest.html">HttpRequest</a> req) {
<a class="jxr_linenumber" name="81" href="#81">81</a>  
<a class="jxr_linenumber" name="82" href="#82">82</a>          String version = req.headers().get(Names.SEC_WEBSOCKET_VERSION);
<a class="jxr_linenumber" name="83" href="#83">83</a>  
<a class="jxr_linenumber" name="84" href="#84">84</a>          <strong class="jxr_keyword">if</strong> (version != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="85" href="#85">85</a>              <strong class="jxr_keyword">if</strong> (version.equals(WebSocketVersion.V13.toHttpHeaderValue())) {
<a class="jxr_linenumber" name="86" href="#86">86</a>                  <em class="jxr_comment">// Version 13 of the wire protocol - RFC 6455 (version 17 of the draft hybi specification).</em>
<a class="jxr_linenumber" name="87" href="#87">87</a>                  <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> WebSocketServerHandshaker13(
<a class="jxr_linenumber" name="88" href="#88">88</a>                          webSocketURL, subprotocols, allowExtensions, maxFramePayloadLength);
<a class="jxr_linenumber" name="89" href="#89">89</a>              } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (version.equals(WebSocketVersion.V08.toHttpHeaderValue())) {
<a class="jxr_linenumber" name="90" href="#90">90</a>                  <em class="jxr_comment">// Version 8 of the wire protocol - version 10 of the draft hybi specification.</em>
<a class="jxr_linenumber" name="91" href="#91">91</a>                  <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> WebSocketServerHandshaker08(
<a class="jxr_linenumber" name="92" href="#92">92</a>                          webSocketURL, subprotocols, allowExtensions, maxFramePayloadLength);
<a class="jxr_linenumber" name="93" href="#93">93</a>              } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (version.equals(WebSocketVersion.V07.toHttpHeaderValue())) {
<a class="jxr_linenumber" name="94" href="#94">94</a>                  <em class="jxr_comment">// Version 8 of the wire protocol - version 07 of the draft hybi specification.</em>
<a class="jxr_linenumber" name="95" href="#95">95</a>                  <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> WebSocketServerHandshaker07(
<a class="jxr_linenumber" name="96" href="#96">96</a>                          webSocketURL, subprotocols, allowExtensions, maxFramePayloadLength);
<a class="jxr_linenumber" name="97" href="#97">97</a>              } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="98" href="#98">98</a>                  <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="99" href="#99">99</a>              }
<a class="jxr_linenumber" name="100" href="#100">100</a>         } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="101" href="#101">101</a>             <em class="jxr_comment">// Assume version 00 where version header was not specified</em>
<a class="jxr_linenumber" name="102" href="#102">102</a>             <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> WebSocketServerHandshaker00(
<a class="jxr_linenumber" name="103" href="#103">103</a>                     webSocketURL, subprotocols, maxFramePayloadLength);
<a class="jxr_linenumber" name="104" href="#104">104</a>         }
<a class="jxr_linenumber" name="105" href="#105">105</a>     }
<a class="jxr_linenumber" name="106" href="#106">106</a> 
<a class="jxr_linenumber" name="107" href="#107">107</a>     <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="108" href="#108">108</a> <em class="jxr_javadoccomment">     * Return that we need cannot not support the web socket version</em>
<a class="jxr_linenumber" name="109" href="#109">109</a> <em class="jxr_javadoccomment">     *</em>
<a class="jxr_linenumber" name="110" href="#110">110</a> <em class="jxr_javadoccomment">     * @param channel</em>
<a class="jxr_linenumber" name="111" href="#111">111</a> <em class="jxr_javadoccomment">     *            Channel</em>
<a class="jxr_linenumber" name="112" href="#112">112</a> <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="113" href="#113">113</a>     <strong class="jxr_keyword">public</strong> <a href="../../../../../../../org/jboss/netty/channel/ChannelFuture.html">ChannelFuture</a> sendUnsupportedWebSocketVersionResponse(<a href="../../../../../../../org/jboss/netty/channel/Channel.html">Channel</a> channel) {
<a class="jxr_linenumber" name="114" href="#114">114</a>         <a href="../../../../../../../org/jboss/netty/handler/codec/http/HttpResponse.html">HttpResponse</a> res = <strong class="jxr_keyword">new</strong> <a href="../../../../../../../org/jboss/netty/handler/codec/http/DefaultHttpResponse.html">DefaultHttpResponse</a>(
<a class="jxr_linenumber" name="115" href="#115">115</a>                 HttpVersion.HTTP_1_1,
<a class="jxr_linenumber" name="116" href="#116">116</a>                 HttpResponseStatus.SWITCHING_PROTOCOLS);
<a class="jxr_linenumber" name="117" href="#117">117</a>         res.setStatus(HttpResponseStatus.UPGRADE_REQUIRED);
<a class="jxr_linenumber" name="118" href="#118">118</a>         res.headers().set(Names.SEC_WEBSOCKET_VERSION, WebSocketVersion.V13.toHttpHeaderValue());
<a class="jxr_linenumber" name="119" href="#119">119</a>         <strong class="jxr_keyword">return</strong> channel.write(res);
<a class="jxr_linenumber" name="120" href="#120">120</a>     }
<a class="jxr_linenumber" name="121" href="#121">121</a> 
<a class="jxr_linenumber" name="122" href="#122">122</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

